<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Filter
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Bz2.php 23775 2011-03-01 17:25:24Z ralph $
 */

/**
 * @see Zend_Filter_Compress_CompressAbstract
 */
require_once 'Zend/Filter/Compress/CompressAbstract.php';

/**
 * Compression adapter for Bz2
 *
 * @category   Zend
 * @package    Zend_Filter
 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Filter_Compress_Bz2 extends Zend_Filter_Compress_CompressAbstract {
	/**
	 * Compression Options
	 * array(
	 * 'blocksize' => Blocksize to use from 0-9
	 * 'archive'   => Archive to use
	 * )
	 *
	 * @var array
	 */
	protected $_options = array ('blocksize' => 4, 'archive' => null );
	
	/**
	 * Class constructor
	 *
	 * @param array|Zend_Config $options (Optional) Options to set
	 */
	public function __construct($options = null) {
		if (! extension_loaded ( 'bz2' )) {
			require_once 'Zend/Filter/Exception.php';
			throw new Zend_Filter_Exception ( 'This filter needs the bz2 extension' );
		}
		parent::__construct ( $options );
	}
	
	/**
	 * Returns the set blocksize
	 *
	 * @return integer
	 */
	public function getBlocksize() {
		return $this->_options ['blocksize'];
	}
	
	/**
	 * Sets a new blocksize
	 *
	 * @param integer $level
	 * @return Zend_Filter_Compress_Bz2
	 */
	public function setBlocksize($blocksize) {
		if (($blocksize < 0) || ($blocksize > 9)) {
			require_once 'Zend/Filter/Exception.php';
			throw new Zend_Filter_Exception ( 'Blocksize must be between 0 and 9' );
		}
		
		$this->_options ['blocksize'] = ( int ) $blocksize;
		return $this;
	}
	
	/**
	 * Returns the set archive
	 *
	 * @return string
	 */
	public function getArchive() {
		return $this->_options ['archive'];
	}
	
	/**
	 * Sets the archive to use for de-/compression
	 *
	 * @param string $archive Archive to use
	 * @return Zend_Filter_Compress_Bz2
	 */
	public function setArchive($archive) {
		$this->_options ['archive'] = ( string ) $archive;
		return $this;
	}
	
	/**
	 * Compresses the given content
	 *
	 * @param  string $content
	 * @return string
	 */
	public function compress($content) {
		$archive = $this->getArchive ();
		if (! empty ( $archive )) {
			$file = bzopen ( $archive, 'w' );
			if (! $file) {
				require_once 'Zend/Filter/Exception.php';
				throw new Zend_Filter_Exception ( "Error opening the archive '" . $archive . "'" );
			}
			
			bzwrite ( $file, $content );
			bzclose ( $file );
			$compressed = true;
		} else {
			$compressed = bzcompress ( $content, $this->getBlocksize () );
		}
		
		if (is_int ( $compressed )) {
			require_once 'Zend/Filter/Exception.php';
			throw new Zend_Filter_Exception ( 'Error during compression' );
		}
		
		return $compressed;
	}
	
	/**
	 * Decompresses the given content
	 *
	 * @param  string $content
	 * @return string
	 */
	public function decompress($content) {
		$archive = $this->getArchive ();
		if (file_exists ( $content )) {
			$archive = $content;
		}
		
		if (file_exists ( $archive )) {
			$file = bzopen ( $archive, 'r' );
			if (! $file) {
				require_once 'Zend/Filter/Exception.php';
				throw new Zend_Filter_Exception ( "Error opening the archive '" . $content . "'" );
			}
			
			$compressed = bzread ( $file );
			bzclose ( $file );
		} else {
			$compressed = bzdecompress ( $content );
		}
		
		if (is_int ( $compressed )) {
			require_once 'Zend/Filter/Exception.php';
			throw new Zend_Filter_Exception ( 'Error during decompression' );
		}
		
		return $compressed;
	}
	
	/**
	 * Returns the adapter name
	 *
	 * @return string
	 */
	public function toString() {
		return 'Bz2';
	}
}
